nix-tools: link to repository from Hackage (homepage, bug-reports, source-repository) - #2545
Open
hamishmack wants to merge 4 commits into
Open
nix-tools: link to repository from Hackage (homepage, bug-reports, source-repository)#2545hamishmack wants to merge 4 commits into
hamishmack wants to merge 4 commits into
Conversation
Add homepage, bug-reports and a source-repository head stanza so the Hackage page for the published nix-tools package links back to this repository (see #1680). The metadata reaches Hackage on the next nix-tools release.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds missing Cabal package metadata so the published nix-tools Hackage page links back to the upstream haskell.nix repository, addressing the discoverability request in #1680.
Changes:
- Add
homepageandbug-reportsURLs pointing to the GitHub repo and issue tracker. - Add a
source-repository headstanza (git + repo URL +subdir) so Hackage can display the upstream source location.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…tools-cabal-metadata
…tools-cabal-metadata
…tools-cabal-metadata
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The published
nix-toolspackage's Hackage page has no link back to its source repository, which the reporter of #1680 needed when cataloguing Haskell-Nix projects.nix-tools/nix-tools/nix-tools.cabalcarried only name/synopsis/license/author/maintainer.This adds the standard linking metadata:
homepage: https://github.com/input-output-hk/haskell.nixbug-reports: https://github.com/input-output-hk/haskell.nix/issuessource-repository headstanza (git, the repo URL,subdir: nix-tools/nix-tools)Testing
cabal checkinnix-tools/nix-tools/parses the manifest cleanly with the new fields — the only diagnostics are pre-existing PVP missing-upper-bound warnings/errors (e.g.base) that are unrelated to this change and present onmaster.Notes
cabal upload --documentation, or relying on Hackage's doc builder), not a source change, and there is no single obvious release checklist in-repo to amend — so it's left as a release-process follow-up (see the static-nix-tools release step tracked in error in flake. #2506) rather than forced into this diff.Closes #1680.